Skip to content

Update Unreal SDK to websocket 2.0#4497

Merged
JasonAtClockwork merged 26 commits intomasterfrom
jlarabie/unreal-sdk-2.0
Mar 18, 2026
Merged

Update Unreal SDK to websocket 2.0#4497
JasonAtClockwork merged 26 commits intomasterfrom
jlarabie/unreal-sdk-2.0

Conversation

@JasonAtClockwork
Copy link
Contributor

@JasonAtClockwork JasonAtClockwork commented Feb 28, 2026 •
edited
Loading

Description of Changes

  • Updated the Unreal SDK and generated Unreal bindings for the websocket 2.0 protocol/model
    • Reworked DbConnectionBase to handle the updated message shapes
    • Switched subscription handling over to new message types and QuerySetId
    • Updated reducer to ReducerResult, removal of callbacks, and set reducer flags
    • Added event table support
  • Baked in multi-module support replacing the old PR
    • Added functionality to generate module support for multiple folders in the Unreal project (add .Build.cs, .h, .cpp) using the --module-name
    • Add new configuration option for spacetime generate to handle module prefix
  • Regenerated Unreal Blackholio/TestClient/QuickstartChat bindings
    • Rebuilt Unreal Blackholio's consume entity to use event tables
  • Updated migration documentation
  • Updated the version bump tool to impact C++

API and ABI breaking changes

  • Unreal websocket/message handling updated to the new protocol
  • Unreal generation now expects a real .uproject target and will stop immediately if project
    metadata is invalid instead of continuing past setup issues.

Expected complexity level and risk

3 - A large set of changes to update the websocket/message handling along with heavy codegen changes to handle multi-module support

Testing

Test coverage of the Unreal SDK will need expansion in a future ticket once our issues with flakiness on CI is resolved.

  • Updated Unreal Blackholio
  • Ran full Unreal SDK test suite
  • Built new test project using the new --module-prefix
  • Run through Unreal Blackholio (C++ and Blueprint)
  • Rebuilt Unreal Blackholio with multi-module, and duplicate generated module testing side-by-side modules that would overlap

Review Question(s)

  • Updates to spacetime init have made the tutorial a little confusing with pathing for the Unreal Blackholio tutorial. To fix though we'd have to update all the commands to be more explicit, or update the tutorial spacetime init to use --project-path . to keep pathing simpler, thoughts?

@JasonAtClockwork JasonAtClockwork self-assigned this Feb 28, 2026
@JasonAtClockwork JasonAtClockwork changed the base branch from jlarabie/cpp-v10 to master March 2, 2026 16:09
@JasonAtClockwork JasonAtClockwork added documentation Improvements or additions to documentation api-break A PR that makes an API breaking change docs deploy whenever Docs updates that aren't tied to a specific release, and should be deployed when convenient. labels Mar 4, 2026
@JasonAtClockwork JasonAtClockwork requested a review from rekhoff March 4, 2026 18:24
@JasonAtClockwork JasonAtClockwork marked this pull request as ready for review March 4, 2026 18:51
@JasonAtClockwork JasonAtClockwork mentioned this pull request Mar 4, 2026
Closed
3 tasks
@JasonAtClockwork
Copy link
Contributor Author

JasonAtClockwork commented Mar 4, 2026 •
edited
Loading

@jdetter I'll work with you on this for the version bump and make sure that is done and reset up once this is ready to merge.

The changes have not been done yet so this comment will need to be resolved before merging. Completed.

@rekhoff
Copy link
Contributor

rekhoff commented Mar 6, 2026

Overall this LGTM. All the key pieces are there.
Regarding having spacetime init use --project-path ., I'm in favor of that path.
The behavior for not supplying a --project-path is covered in the ChatApp tutorial.
The Unity tutorial uses --server-only in it's init to avoid the issue.
So there is already precedent for using additional commands on init, so if we provide a small blurb about --project-path I think that'd be the best user experience.

@JasonAtClockwork
Copy link
Contributor Author

JasonAtClockwork commented Mar 10, 2026

Overall this LGTM. All the key pieces are there. Regarding having spacetime init use --project-path ., I'm in favor of that path. The behavior for not supplying a --project-path is covered in the ChatApp tutorial. The Unity tutorial uses --server-only in it's init to avoid the issue. So there is already precedent for using additional commands on init, so if we provide a small blurb about --project-path I think that'd be the best user experience.

So --server-only doesn't seem to work that way any longer it still opens interactive mode and asks for a directory which is where I was concerned and why I think someone in the Discord ran into an issue with generate. I've updated to use --project-path and tested locally which seems much more aligned to the previous documentation so this is much better.

rekhoff
rekhoff approved these changes Mar 10, 2026
View reviewed changes
Copy link
Contributor

@rekhoff rekhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My concerns have been addressed. I have not tested the PR, but this looks good to me.

rekhoff
rekhoff reviewed Mar 13, 2026
View reviewed changes
Copy link
Contributor

@rekhoff rekhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I only have some minor nits with grammar/phrasing. Otherwise this looks good to me.

JasonAtClockwork and others added 3 commits March 13, 2026 12:33
@JasonAtClockwork @rekhoff
Update docs/docs/00300-resources/00100-how-to/00600-migrating-to-2.0.md
1b13683 
Co-authored-by: Ryan <r.ekhoff@clockworklabs.io>
Signed-off-by: Jason Larabie <jason@clockworklabs.io>
@JasonAtClockwork @rekhoff
Update docs/docs/00100-intro/00300-tutorials/00400-unreal-tutorial/00…
60ef612 
…300-part-2.md

Co-authored-by: Ryan <r.ekhoff@clockworklabs.io>
Signed-off-by: Jason Larabie <jason@clockworklabs.io>
@JasonAtClockwork
Merge branch 'master' into jlarabie/unreal-sdk-2.0
1d00844
jdetter
jdetter approved these changes Mar 18, 2026
View reviewed changes
Copy link
Collaborator

@jdetter jdetter left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor questions/nits in the docs which is where I did a majority of my thorough pass. The quantity of code changes here makes it quite hard to review via the Github UI so I wasn't able to do a very thorough pass on the code. If a more thorough code review is required we should break any generated code into a separate PR and base that on this PR, otherwise the Github UI is pretty unusable.

I don't have anything that would block this PR from merging but again I didn't do a very thorough pass on the code changes here.

Update: I looked at the tools/upgrade-version/src/main.rs changes and also the generate.rs changes and both of those look good to me.

@JasonAtClockwork JasonAtClockwork added this pull request to the merge queue Mar 18, 2026
Merged via the queue into master with commit f8d6d76 Mar 18, 2026
33 of 34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rekhoff rekhoff rekhoff approved these changes

@jdetter jdetter jdetter approved these changes

@bfops bfops Awaiting requested review from bfops bfops is a code owner

@cloutiertyler cloutiertyler Awaiting requested review from cloutiertyler cloutiertyler is a code owner

Assignees

@JasonAtClockwork JasonAtClockwork

Labels

api-break A PR that makes an API breaking change docs deploy whenever Docs updates that aren't tied to a specific release, and should be deployed when convenient. documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@JasonAtClockwork @rekhoff @jdetter